Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add check_only template for publishing platform integrations #18596

Conversation

james-eichelbaum
Copy link
Contributor

@james-eichelbaum james-eichelbaum commented Sep 16, 2024

Adds a new check_only option for ddev create - this option enables the creation of agent checks when the manifest already exists and prefills the appropriate information from the manifest. It also includes a --skip-manifest flag which will prompt disable checking for the manifest and using its fields, but still avoid creating the non-agent check files that are typically required. The intention of this is to be used with publishing platform, where the non-code portions of the integration have already been created in github or otherwise.

Test plan

Happy path: ddev create -t check_only my_integration

ddev create -t check_only test_integration     
Make sure to use the display name. e.g. MapR, Ambari, IBM MQ, vSphere, ...
Do you want to continue? [y/N]: y
Created in `~/dd/marketplace`:
acme_inc_test_integration
├── datadog_checks
│   └── acme_inc_test_integration
│       └── config_models
│           ├── __init__.py
│           ├── defaults.py
│           ├── instance.py
│           ├── shared.py
│           └── validators.py
│       └── data
│           └── conf.yaml.example
│       ├── __about__.py
│       ├── __init__.py
│       └── check.py
│   └── __init__.py
├── tests
│   ├── __init__.py
│   ├── conftest.py
│   └── test_unit.py
├── hatch.toml
└── pyproject.toml

No manifest: ddev create -t check_only my_integration --skip-manifest

ddev create -t check_only test_integration --skip-manifest
Make sure to use the display name. e.g. MapR, Ambari, IBM MQ, vSphere, ...
Do you want to continue? [y/N]: y
Email used for support requests: test
Your Company Name: test
The product or company homepage: test
Email used for subscription notifications: test
Created in `~/dd/marketplace`:
test_test_integration
├── datadog_checks
│   └── test_test_integration
│       └── config_models
│           ├── __init__.py
│           ├── defaults.py
│           ├── instance.py
│           ├── shared.py
│           └── validators.py
│       └── data
│           └── conf.yaml.example
│       ├── __about__.py
│       ├── __init__.py
│       └── check.py
│   └── __init__.py
├── tests
│   ├── __init__.py
│   ├── conftest.py
│   └── test_unit.py
├── hatch.toml
└── pyproject.toml

Regression test: ddev create -t check my_integration

ddev create -t check test_integration2                    
Make sure to use the display name. e.g. MapR, Ambari, IBM MQ, vSphere, ...
Do you want to continue? [y/N]: y
Email used for support requests: test
Your Company Name: test
The product or company homepage: test
Email used for subscription notifications: test
Created in `~/dd/marketplace`:
test_test_integration2
├── assets
│   └── configuration
│       └── spec.yaml
│   └── dashboards
│       └── test_test_integration2_overview.json
│   └── service_checks.json
├── datadog_checks
│   └── test_test_integration2
│       └── config_models
│           ├── __init__.py
│           ├── defaults.py
│           ├── instance.py
│           ├── shared.py
│           └── validators.py
│       └── data
│           └── conf.yaml.example
│       ├── __about__.py
│       ├── __init__.py
│       └── check.py
│   └── __init__.py
├── images
│   └── IMAGES_README.md
├── tests
│   ├── __init__.py
│   ├── conftest.py
│   └── test_unit.py
├── CHANGELOG.md
├── README.md
├── hatch.toml
├── manifest.json
├── metadata.csv
└── pyproject.toml

ECOS-1617

@james-eichelbaum james-eichelbaum changed the title add agent_check template for publishing platform integrations add check_only template for publishing platform integrations Sep 16, 2024
Copy link

codecov bot commented Sep 16, 2024

Codecov Report

Attention: Patch coverage is 12.50000% with 14 lines in your changes missing coverage. Please review.

Project coverage is 89.55%. Comparing base (2a83f38) to head (41e9701).
Report is 4 commits behind head on master.

Additional details and impacted files
Flag Coverage Δ
activemq ?
cassandra ?
datadog_checks_dev 77.46% <12.50%> (-0.19%) ⬇️
hive ?
hivemq ?
ignite ?
jboss_wildfly ?
kafka ?
presto ?
solr ?

Flags with carried forward coverage won't be shown. Click here to find out more.

@james-eichelbaum james-eichelbaum force-pushed the jte/09-13-add_agent_check_template_for_publishing_platform_integrations branch 5 times, most recently from 9bd0cf3 to cafad04 Compare September 16, 2024 19:20
@james-eichelbaum james-eichelbaum force-pushed the jte/09-13-add_agent_check_template_for_publishing_platform_integrations branch from cafad04 to e469a2a Compare September 16, 2024 20:20
iliakur
iliakur previously approved these changes Sep 20, 2024
Copy link
Contributor

@iliakur iliakur left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

on a cursory glance looks good!

docs/developer/setup.md Show resolved Hide resolved
@james-eichelbaum james-eichelbaum force-pushed the jte/09-13-add_agent_check_template_for_publishing_platform_integrations branch from 6914a34 to 46c6a09 Compare September 23, 2024 14:06
@james-eichelbaum james-eichelbaum marked this pull request as ready for review September 23, 2024 14:44
@james-eichelbaum james-eichelbaum requested review from a team as code owners September 23, 2024 14:44
alai97
alai97 previously approved these changes Sep 23, 2024
Copy link
Contributor

@alai97 alai97 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good for docs

@HadhemiDD HadhemiDD merged commit d4157fc into master Sep 25, 2024
38 checks passed
@HadhemiDD HadhemiDD deleted the jte/09-13-add_agent_check_template_for_publishing_platform_integrations branch September 25, 2024 14:28
github-actions bot pushed a commit that referenced this pull request Sep 25, 2024
* add agent_check template for publishing platform integrations

* add option to skip manifest checks

* add changelog entry

* remove unused import

---------

Co-authored-by: HadhemiDD <[email protected]> d4157fc
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants